POST api/authentication/{authenticationKey}

This method is used to obtain an authorization token from Epic based on an authorization key and credentials provided to the third party. This token will be valid for a configurable period of time then will expire. This token will be used for all other Epic requests.

Request Information

URI Parameters

Name	Description	Type	Additional information
authenticationKey	This is the key provided to the third party for authentication purposes.	string	Required

Body Parameters

This contains the credentials provided to the 3rd party for authentication. May also contain the user key for an aliased user.

AuthenticationModel

Name	Description	Type	Additional information
UserName	This field is the user name assigned to the 3rd party accesing the Epic API.	string	None.
Password	This field is the password assigned to the 3rd party accesing the Epic API.	string	None.
AliasedUserKey	This field is the optional user key representing the user being aliased. This allows the API account to perform actions on behalf of the Epic user. If this value is left blank, the API user account will be used.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserName": "sample string 1",
  "Password": "sample string 2",
  "AliasedUserKey": "sample string 3"
}

application/xml, text/xml

Sample:

<AuthenticationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <AliasedUserKey>sample string 3</AliasedUserKey>
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</AuthenticationModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The authentication token that will be used for subsequent requests. If the passed in authentication key is invalid, then "Invalid" is returned.

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>